<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class utb_file</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class utb_file</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">File Container</p>
<p class="description"><p>Contains methods for utilizing a single transfer file.</p></p>
		<p class="notes">
			Located in <a class="field" href="_gui---index.php.html">/gui/index.php</a> (line <span class="field"><a href="../../__filesource/fsource_bridge__guiindex.php.html#a2452">2452</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../bridge/file/utb_file_rtorrent.html">utb_file_rtorrent</a></td>
					<td>
											rTorrent File Container
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$name" title="details" class="var-name">$name</a>
				</div>
																<div class="var-title">
					<span class="var-type">integer</span>
					<a href="#$priority" title="details" class="var-name">$priority</a>
				</div>
																<div class="var-title">
					<span class="var-type">integer</span>
					<a href="#$size" title="details" class="var-name">$size</a>
				</div>
																<div class="var-title">
					<span class="var-type">integer</span>
					<a href="#$size_downloaded" title="details" class="var-name">$size_downloaded</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																				
												<div class="method-definition">
											<span class="method-result">utb_file</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#serialize" title="details" class="method-name">serialize</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_name" title="details" class="method-name">set_name</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_priority" title="details" class="method-name">set_priority</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_size" title="details" class="method-name">set_size</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_size_downloaded" title="details" class="method-name">set_size_downloaded</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$name" id="$name"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$name</span>
						(line <span class="line-number"><a href="../../__filesource/fsource_bridge__guiindex.php.html#a2465">2465</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">File Name</p>
<p class="description"><p>Name of file.</p></p>
	<ul class="tags">
				<li><span class="field">internal:</span> String value required</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$priority" id="$priority"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">integer</span>
			<span class="var-name">$priority</span>
			 = <span class="var-default"> UTORRENT_PRIORITY_LOW</span>			(line <span class="line-number"><a href="../../__filesource/fsource_bridge__guiindex.php.html#a2511">2511</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">File Priority</p>
<p class="description"><p>Priority of file.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../bridge/_gui---index.php.html#defineUTORRENT_PRIORITY_EXCLUDE">UTORRENT_PRIORITY_EXCLUDE</a></li>
				<li><span class="field">see:</span> <a href="../../bridge/_gui---index.php.html#defineUTORRENT_PRIORITY_NORMAL">UTORRENT_PRIORITY_NORMAL</a></li>
				<li><span class="field">see:</span> <a href="../../bridge/_gui---index.php.html#defineUTORRENT_PRIORITY_HIGH">UTORRENT_PRIORITY_HIGH</a></li>
				<li><span class="field">see:</span> <a href="../../bridge/_gui---index.php.html#defineUTORRENT_PRIORITY_LOW">UTORRENT_PRIORITY_LOW</a></li>
				<li><span class="field">internal:</span> Integer value required</li>
				<li><span class="field">internal:</span> Defaults to UTORRENT_PRIORITY_LOW</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$size" id="$size"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">integer</span>
			<span class="var-name">$size</span>
			 = <span class="var-default"> 0</span>			(line <span class="line-number"><a href="../../__filesource/fsource_bridge__guiindex.php.html#a2479">2479</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Total File Size</p>
<p class="description"><p>Total size of file in bytes.</p></p>
	<ul class="tags">
				<li><span class="field">internal:</span> Defaults to 0</li>
				<li><span class="field">internal:</span> Integer value (in bytes) required</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$size_downloaded" id="$size_downloaded"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">integer</span>
			<span class="var-name">$size_downloaded</span>
			 = <span class="var-default"> 0</span>			(line <span class="line-number"><a href="../../__filesource/fsource_bridge__guiindex.php.html#a2493">2493</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Downloaded File Size</p>
<p class="description"><p>Downloaded size of file in bytes.</p></p>
	<ul class="tags">
				<li><span class="field">internal:</span> Defaults to 0</li>
				<li><span class="field">internal:</span> Integer value (in bytes) required</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../../__filesource/fsource_bridge__guiindex.php.html#a2523">2523</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">File Class Constructor</p>
<p class="description"><p>Parses file data and assigns class values.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> ryon.sherman</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">utb_file</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$data</span><span class="var-description">: Array of file data</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../../bridge/file/utb_file_rtorrent.html#method__construct">utb_file_rtorrent::__construct()</a>
								: rTorrent File Class Constructor
							</li>
				</ul>
	</div>
<a name="methodserialize" id="serialize"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">serialize</span> (line <span class="line-number"><a href="../../__filesource/fsource_bridge__guiindex.php.html#a2645">2645</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Serialize File Object Data</p>
<p class="description"><p>Retrieves sorted array of class values.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Array of class values</li>
				<li><span class="field">author:</span> ryon.sherman</li>
				<li><span class="field">internal:</span> Used for JSON conversion</li>
				<li><span class="field">internal:</span> Returned array is order sensitive</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			serialize
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodset_name" id="set_name"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">set_name</span> (line <span class="line-number"><a href="../../__filesource/fsource_bridge__guiindex.php.html#a2551">2551</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set File Name</p>
<p class="description"><p>Parses array of file data and assigns the  'name' class value.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> ryon.sherman</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_name
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$data</span><span class="var-description">: Array of file data</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_priority" id="set_priority"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">set_priority</span> (line <span class="line-number"><a href="../../__filesource/fsource_bridge__guiindex.php.html#a2620">2620</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set File Priority</p>
<p class="description"><p>Parses array of file data and assigns the  'priority' class value.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> ryon.sherman</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_priority
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$data</span><span class="var-description">: Array of file data</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_size" id="set_size"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">set_size</span> (line <span class="line-number"><a href="../../__filesource/fsource_bridge__guiindex.php.html#a2574">2574</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Total File Size</p>
<p class="description"><p>Parses array of file data and assigns the  'size' class value.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> ryon.sherman</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_size
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$data</span><span class="var-description">: Array of file data</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../../bridge/file/utb_file_rtorrent.html#methodset_size">utb_file_rtorrent::set_size()</a>
								: Set Total File Size Override
							</li>
				</ul>
	</div>
<a name="methodset_size_downloaded" id="set_size_downloaded"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">set_size_downloaded</span> (line <span class="line-number"><a href="../../__filesource/fsource_bridge__guiindex.php.html#a2597">2597</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Downloaded File Size</p>
<p class="description"><p>Parses array of file data and assigns the  'size_downloaded' class value.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> ryon.sherman</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_size_downloaded
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$data</span><span class="var-description">: Array of file data</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../../bridge/file/utb_file_rtorrent.html#methodset_size_downloaded">utb_file_rtorrent::set_size_downloaded()</a>
								: Set Downloaded File Size Override
							</li>
				</ul>
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Wed, 16 Dec 2009 10:32:58 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>